home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2005 October / PCWOCT05.iso / Software / FromTheMag / XAMPP 1.4.14 / xampp-win32-1.4.14-installer.exe / xampp / php / pear / docs / PhpDocumentor / Release-1.2.0beta3 < prev    next >
Text File  |  2004-03-24  |  10KB  |  222 lines
  1. $Id: Release-1.2.0beta3,v 1.2 2003/02/02 22:02:56 CelloG Exp $
  2.  
  3. PhpDocumentor Version 1.2.0 BETA 3
  4. ################################################################################
  5. http://www.phpdoc.org
  6. Joshua Eichorn jeichorn@phpdoc.org
  7. Gregory Beaver cellog@users.sourceforge.net
  8. ################################################################################
  9. ################################################################################
  10.  
  11. The phpDocumentor team would like to announce the release of phpDocumentor
  12. 1.2.0 BETA 3.  This is a beta release and may have bugs and may have a different
  13. structure from the final release.  This beta differs from 1.2.0Beta in that it
  14. should work from pear install PhpDocumentor, and has a few bugs fixed and a few
  15. extra features.
  16.  
  17. for PEAR users, the new --pear command-line switch will be a boon.  Leave it on
  18. by default if your package follows PEAR coding and directory naming standards
  19.  
  20. IMPORTANT: phpDocumentor 1.2.0 BETA 3 requires PHP version 4.1.0 or greater.
  21. phpDocumentor will function best with PHP version 4.3.0 or greater, as it will
  22. use of the tokenizer extension if php 4.3.0 is installed for a tremendous
  23. increase in parsing speed.
  24.  
  25. phpDocumentor is a JavaDoc-like automatic documentation generator for PHP
  26. written in PHP.  It is the most versatile tool for documenting PHP.
  27.  
  28. Once again, phpDocumentor brings a great increase in usability with the 1.2
  29. branch.  The addition of a tokenizer-based parser increases parsing speed by
  30. up to 4 times (that's 400% faster) compared to previous versions.  In addition,
  31. scalability has been improved, allowing generation of documents in multiple
  32. output formats with one command.  The usage of config files makes repetitive
  33. parsing tasks straightforward and reduces the chance for error.
  34.  
  35. The addition of DocBlock templates, extended documentation (tutorials) parsing,
  36. and many other new features make this release the most useful automatic
  37. documentor for any programming language.
  38.  
  39. The default HTML Converter has been ported to a new Smarty-based converter,
  40. HTMLframesConverter, and all of the old templates have been ported to the new
  41. Smarty-based format.  The HTMLdefaultConverter has been deprecated since its
  42. functionality is redundant.  Due to the time it takes to convert a template to
  43. the new format, the phpDocumentor team extends an offer to do this conversion
  44. for anyone who has a brand new template.  We may also include the template in a
  45. future release, if permission is granted.
  46.  
  47. Due to interest from PEAR programmers, there is a new beta-quality XML:DocBook
  48. converter with peardoc2 templates.  This converter could also generate other
  49. DocBook formats, if desired, but does not generate indexing for this release.
  50.  
  51. The PDF Converter has stepped up to beta-quality, is fully templatable, and
  52. has most bugs completely fixed.  The CHM converter has also taken major strides
  53. and is close to beta quality.
  54.  
  55. As predicted, the Smarty template engine is the primary template engine for
  56. all converters.
  57.  
  58. For users new to phpDocumentor, phpDocumentor uses an event-driven parser
  59. and intermediary data structures that allow it to perform at a level other
  60. automatic documentors for PHP cannot achieve:
  61.   --parsing any php file, with multiple classes and functions in the same file
  62.   --fully compliant with even the most esoteric php syntax 
  63.       ($string = <<< EOF, for example)
  64.   --ability to generate multiple output formats
  65.   --extremely fast parsing
  66.   --error/warnings by line number and file to allow for debugging of
  67.     documentation tags
  68.   --multiple output templates to easily customize the look of generated
  69.     documentation
  70.   --extensive documentation of the package, including a detailed specification
  71.     for tags and the included template engine
  72.   --open source, GPL
  73.   
  74.  
  75. A full listing of all closed bugs and feature requests can be found in the 
  76. next section of the notes
  77.  
  78. phpDocumentor 1.2.0BETA3 is not ready for production use documenting any PHP
  79. project, download it and try the most advanced solution for PHP documentation
  80. today to help us find the last persistent bugs.  There are MANY in the new
  81. XML DocBook Converter.  Please try it out and find them so we can begin to fix
  82. them.
  83.  
  84. ################################################################################
  85.  
  86. The following bugs are fixed in version 1.2.0BETA3
  87.  [ 661317 ] PDF converter in subpackage ids broken
  88.  [ 669945 ] CHM: "undefined function: convert()" with multiple outputs 
  89.  [ 670205 ] inherited methods have no links
  90.  [ 670341 ] <pre> in docblock doesn't htmlentitie
  91.  [ 670350 ] left_frame.tpl missing package level doc link
  92.  [ 670440 ] Io::getBase() is buggy
  93.  [ 670903 ] inline desc <code> not <pre>-ized
  94.  [ 671620 ] warning in Parser line 2271
  95.  [ 672149 ] @desc broken
  96.  [ 674053 ] Support for require_once 
  97.  [ 674059 ] requires PHP version 4.2 or higher
  98.  [ 674075 ] Bad @param kills parser
  99.  [ 677105 ] unbalanced HTML-comments in output of HTML:frames:phpedit
  100.  [ 677821 ] define not parsed right in highlightparser
  101.  [ 677822 ] {@source} not showing whole source
  102.  [ 677826 ] nonsense @link in @see breaks HTML output
  103.  [ 677938 ] whitespace wrong after certain docblocks
  104.  
  105. The following bugs are fixed in version 1.2.0BETA2
  106.  [ 665707 ] Warnings and errors in new_phpdoc.php
  107.  [ 666307 ] whitespace not ignored in @param
  108.  [ 669132 ] "no @package tag was used" error but @ignore & @package used
  109.  [ 669525 ] {$children[kids].sdesc} contains parent sdesc
  110.  [ 669613 ] Call to undefined function: getclassleft()
  111.  [ 669615 ] methods disapper
  112.  [ 669640 ] javadocdesc broken
  113.  [ 669909 ] PDF text starts off left side of page when have package.html
  114.  
  115. The following bugs are fixed in version 1.2.0BETA1a
  116.  [ 661976 ] @see broken
  117.  [ 662630 ] {} delimited variables within strings mess up the parser
  118.  [ 663435 ] define values, global variable values need htmlentities
  119.  [ 664058 ] @param not displayed in HTMLframesConverter 
  120.  
  121. The following bugs are fixed in version 1.2.0BETA1
  122.  
  123.  [ 586357 ] ignore a directory
  124.  [ 637921 ] sorting is weird with multiple package
  125.  [ 637928 ] multiple converters legal, but fails
  126.  [ 638042 ] two declarations of checkstate()
  127.  [ 638128 ] commandline win32 fails, w/relative path
  128.  [ 639553 ] new_phpdoc.php fails with php 4.2.3
  129.  [ 640507 ] constructor links broken
  130.  [ 641076 ] second instance of loop fails
  131.  [ 641235 ] need trim of -f and -d commandline
  132.  [ 641334 ] parse <script language="php"> as <?php
  133.  [ 642427 ] Incorrect Anchor link from elementIndex
  134.  [ 645588 ] elements named "function.." or "global.." don't link
  135.  [ 646281 ] {@link mailto:e@a descrip} broken
  136.  [ 647494 ] {@link element1, element2} incorrect
  137.  [ 648684 ] links to global vars, defines in Smarty wrong
  138.  [ 649646 ] comments not parsed in function
  139.  [ 649953 ] phpdoc command-line only runs from install dir
  140.  [ 650946 ] link to phpdoc.org new window
  141.  [ 651837 ] getLink broken in rare case
  142.  [ 653627 ] @staticvar broken
  143.  [ 654429 ] tutorial prev/next links not working
  144.  [ 655372 ] smarty template not found in pdf convers
  145.  [ 657041 ] {@source} doesn't work right
  146.  [ 657387 ] parent/child tutorials converted twice
  147.  [ 657726 ] used by link htmlentitiezed
  148.  [ 657739 ] need separate categories of {@tags}
  149.  [ 657934 ] subtrees not processed in Converter
  150.  [ 658120 ] PDF define template has bug
  151.  [ 658121 ] PDF Converter not passing elements sorte
  152.  [ 661316 ] @tutorial tutorial.ext#subsection.section broken
  153.  
  154. There of course were other small bugs fixed, these were just the bugs with 
  155. entries in source forge.  You can view the bug details or reopen it if
  156. you think it's not totally fixed at:
  157. http://sourceforge.net/tracker/?group_id=11194&atid=111194
  158.  
  159. Features added that had Feature Request entries in SF for 1.2.0 beta 3:
  160.  [ 674470 ] output a list of all @todos
  161.  [ 675194 ] -cp for converter-specific dynamic params 
  162.  
  163. Features added that had Feature Request entries in SF for 1.2.0 beta 2:
  164.  [ 650251 ] @filesource tag 
  165.  [ 670184 ] @example tag 
  166.  [ 670189 ] @internal/{@internal}} 
  167.  [ 670190 ] --ignore-tags command-line 
  168.  
  169. Features added that had Feature Request entries in SF for 1.2.0 beta 1a:
  170.  [ 663436 ] --title available in all pages, html
  171.  [ 663437 ] error if @package is missing 
  172.  [ 663439 ] PEAR command-line switch 
  173.  
  174. Features added that had Feature Request entries in SF for 1.2.0 beta 1:
  175.  
  176.  [ 541896 ] Create an Extended Howto
  177.  [ 558118 ] add {@inheritDoc}
  178.  [ 562604 ] Using @access blocs (_start ... _end)
  179.  [ 564991 ] auto-links to php manual
  180.  [ 566942 ] add {@link seeelement descrip}
  181.  [ 569746 ] make Program_root/ template thing
  182.  [ 577714 ] have master directory option
  183.  [ 586401 ] @access protected
  184.  [ 608603 ] REQUEST:class/function usage information
  185.  [ 615419 ] manuals like "php.net manual"
  186.  [ 623055 ] Zend IDE suport
  187.  [ 634518 ] inherit @author, @version, @copyright
  188.  [ 634589 ] @uses element
  189.  [ 634641 ] A way to document form variables
  190.  [ 635184 ] update all templates to phphtmllib
  191.  [ 637409 ] {keyword} - {data} pairs not flexible
  192.  [ 637660 ] parse type|type
  193.  [ 637920 ] simple way to extend a converter
  194.  [ 642235 ] Index of phphtmllib template
  195.  [ 645775 ] line numbers for elements
  196.  [ 651275 ] tutorials
  197.  [ 651716 ] automatically find README/INSTALL
  198.  [ 651723 ] @tutorial/{@tutorial}
  199.  [ 653608 ] allow the /user ini dir to be configable 
  200.  
  201. ################################################################################
  202.  
  203. The documentation has been updated for this release you can view it at
  204. http://phpdocu.sourceforge.net/spec/
  205. or in the distribution in the spec directory
  206.  
  207. The changelog is available in the tarball, or online at 
  208. http://phpdocu.sourceforge.net/Changelog
  209.  
  210. You can download the newest version from 
  211. http://phpdocu.sourceforge.net/downloads.php
  212.  
  213. And of course you can reach the webpage at http://phpdocu.sourceforge.net/ or 
  214. http://phpdoc.org/ 
  215.  
  216. enjoy
  217. -joshua eichorn <jeichorn@phpdoc.org>
  218. -gregory beaver <cellog@users.sourceforge.net>
  219.  
  220.  
  221. vim: set expandtab :
  222.